The Status Structure(IM:XP)

The Status Structure
QuickDraw GX defines status type IDs to report various conditions. Not all of these conditions can be reported from the application. For example, although QuickDraw GX defines a status ID for the percentage completion of a print job, it is not available to the application because printing takes place in the background. Status type IDs are specified in the following enumeration:
struct gxStatusRecord {
   unsigned short statusType;
   unsigned short statusId;
   unsigned short statusAlertId;
   Signature      statusOwner;      
   short          statResId;  
   short          statResIndex;     
   short          dialogResult;     
   unsigned short bufferLen;
   char           statusBuffer[1];     
};
typedef struct gxStatusRecord gxStatusRecord;
Field Description

statusType
The type of status that this structure represents. This is one of the values shown in Table 4-5.
statusId
The ID of the status that this structure represents. If the value of this field is 0, there is no associated printing alert ('plrt') resource.
statusAlertId
The ID of the printing alert for this status.
statusOwner
The creator type of the owner of this status structure.
statResId
The resource ID for the status ('stat') resource used to process this status.
statResIndex
The index value for indexing into the status resource for this status.
dialogResult
The ID of the button string that was selected to dismiss the printing alert box associated with this status.
bufferLen
The number of bytes in the status buffer.
statusBuffer
This field is a buffer for the caller to store any additional information for use by the status-handling function.
Note
The triplet of values that includes the statusOwner, statResId, and statResIndex fields must be unique for each status structure.
Table 4-5 shows the status types that you can specify in a status structure.
Table 4-5 Status type IDs
Constant Value Explanation
gxNonFatalError 1 Affects the icon in the status dialog box
gxFatalError 2 Sends a printing alert to the status dialog box
gxPrinterReady 3 Signals QuickDraw GX to leave alert mode
gxUserAttention 4 Signals initiation of a modal dialog box
gxUserAlert 5 Signals initiation of a printing alert box
gxPageTransmission 6 Signals that a page was sent to the printer and decrements the page counts in strings that are displayed to the user
gxOpenConnectionStatus 7 Signals QuickDraw GX to begin animation on printer icon
gxInformationalStatus 8 Specifies the default status type and has no side effects
gxSpoolingPageStatus 9 Signals that a page was spooled and increments the page count in the status dialog box
gxEndStatus 10 Signals that spooling has ended
gxPercentageStatus 11 Signals QuickDraw GX as to the amount of the job that is currently complete

**Table 4-5 Status type IDs**
Constant	Value	Explanation
`gxNonFatalError`	1	Affects the icon in the status dialog box
`gxFatalError`	2	Sends a printing alert to the status dialog box
`gxPrinterReady`	3	Signals QuickDraw GX to leave alert mode
`gxUserAttention`	4	Signals initiation of a modal dialog box
`gxUserAlert`	5	Signals initiation of a printing alert box
`gxPageTransmission`	6	Signals that a page was sent to the printer and decrements the page counts in strings that are displayed to the user
`gxOpenConnectionStatus`	7	Signals QuickDraw GX to begin animation on printer icon
`gxInformationalStatus`	8	Specifies the default status type and has no side effects
`gxSpoolingPageStatus`	9	Signals that a page was spooled and increments the page count in the status dialog box
`gxEndStatus`	10	Signals that spooling has ended
`gxPercentageStatus`	11	Signals QuickDraw GX as to the amount of the job that is currently complete